home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / pack.n < prev    next >
Text File  |  1994-09-20  |  16KB  |  462 lines
  1. '\"
  2. '\" Copyright (c) 1990-1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/pack.n,v 1.11 93/09/12 21:43:11 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS pack tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. pack \- Geometry manager that packs around edges of cavity
  210. .SH SYNOPSIS
  211. \fBpack \fIoption arg \fR?\fIarg ...\fR?
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. The \fBpack\fR command is used to communicate with the packer,
  217. a geometry manager that arranges the children of a parent by
  218. packing them in order around the edges of the parent.
  219. The \fBpack\fR command can have any of several forms, depending
  220. on the \fIoption\fR argument:
  221. .TP
  222. \fBpack \fIslave \fR?\fIslave ...\fR? ?\fIoptions\fR?
  223. If the first argument to \fBpack\fR is a window name (any value
  224. starting with ``.''), then the command is processed in the same
  225. way as \fBpack configure\fR.
  226. .TP
  227. \fBpack configure \fIslave \fR?\fIslave ...\fR? ?\fIoptions\fR?
  228. The arguments consist of the names of one or more slave windows
  229. followed by pairs of arguments that specify how
  230. to manage the slaves.
  231. See ``THE PACKER ALGORITHM'' below for details on how the options
  232. are used by the packer.
  233. The following options are supported:
  234. .RS
  235. .TP
  236. \fB\-after \fIother\fR
  237. \fIOther\fR must the name of another window.
  238. Use its master as the master for the slaves, and insert
  239. the slaves just after \fIother\fR in the packing order.
  240. .TP
  241. \fB\-anchor \fIanchor\fR
  242. \fIAnchor\fR must be a valid anchor position such as \fBn\fR
  243. or \fBsw\fR; it specifies where to position each slave in its
  244. parcel.
  245. Defaults to \fBcenter\fR.
  246. .TP
  247. \fB\-before \fIother\fR
  248. \fIOther\fR must the name of another window.
  249. Use its master as the master for the slaves, and insert
  250. the slaves just before \fIother\fR in the packing order.
  251. .TP
  252. \fB\-expand \fIboolean\fR
  253. Specifies whether the slaves should be expanded to consume
  254. extra space in their master.
  255. \fIBoolean\fR may have any proper boolean value, such as \fB1\fR
  256. or \fBno\fR.
  257. Defaults to 0.
  258. .TP
  259. \fB\-fill \fIstyle\fR
  260. If a slave's parcel is larger than its requested dimensions, this
  261. option may be used to stretch the slave.
  262. \fIStyle\fR must have one of the following values:
  263. .RS
  264. .TP
  265. \fBnone\fR
  266. Give the slave its requested dimensions plus any internal padding
  267. requested with \fB\-ipadx\fR or \fB\-ipady\fR.  This is the default.
  268. .TP
  269. \fBx\fR
  270. Stretch the slave horizontally to fill the entire width of its
  271. parcel (except leave external padding as specified by \fB\-padx\fR).
  272. .TP
  273. \fBy\fR
  274. Stretch the slave vertically to fill the entire height of its
  275. parcel (except leave external padding as specified by \fB\-pady\fR).
  276. .TP
  277. \fBboth\fR
  278. Stretch the slave both horizontally and vertically.
  279. .RE
  280. .TP
  281. \fB\-in \fIother\fR
  282. Insert the slave(s) at the end of the packing order for the master
  283. window given by \fIother\fR.
  284. .TP
  285. \fB\-ipadx \fIamount\fR
  286. \fIAmount\fR specifies how much horizontal internal padding to
  287. leave on each side of the slave(s).
  288. \fIAmount\fR must be a valid screen distance, such as \fB2\fR or \fB.5c\fR.
  289. It defaults to 0.
  290. .TP
  291. \fB\-ipady \fIamount\fR
  292. \fIAmount\fR specifies how much vertical internal padding to
  293. leave on each side of the slave(s).
  294. \fIAmount\fR  defaults to 0.
  295. .TP
  296. \fB\-padx \fIamount\fR
  297. \fIAmount\fR specifies how much horizontal external padding to
  298. leave on each side of the slave(s).
  299. \fIAmount\fR defaults to 0.
  300. .TP
  301. \fB\-pady \fIamount\fR
  302. \fIAmount\fR specifies how much vertical external padding to
  303. leave on each side of the slave(s).
  304. \fIAmount\fR defaults to 0.
  305. .TP
  306. \fB\-side \fIside\fR
  307. Specifies which side of the master the slave(s) will be packed against.
  308. Must be \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR.
  309. Defaults to \fBtop\fR.
  310. .LP
  311. If no \fB\-in\fR, \fB\-after\fR or \fB\-before\fR option is specified
  312. then each of the slaves will be inserted at the end of the packing list
  313. for its parent unless it is already managed by the packer (in which
  314. case it will be left where it is).
  315. If one of these options is specified then all the slaves will be
  316. inserted at the specified point.
  317. If any of the slaves are already managed by the geometry manager
  318. then any unspecified options for them retain their previous values rather
  319. than receiving default values.
  320. .RE
  321. .TP
  322. \fBpack forget \fIslave \fR?\fIslave ...\fR?
  323. Removes each of the \fIslave\fRs from the packing order for its
  324. master and unmaps their windows.
  325. The slaves will no longer be managed by the packer.
  326. .TP
  327. \fBpack newinfo \fIslave\fR
  328. Returns a list whose elements are the current configuration state of
  329. the slave given by \fIslave\fR in the same option-value form that
  330. might be specified to \fBpack configure\fR.
  331. The first two elements of the list are ``\fB\-in \fImaster\fR'' where
  332. \fImaster\fR is the slave's master.
  333. Starting with Tk 4.0 this option will be renamed "pack info".
  334. .TP
  335. \fBpack propagate \fImaster\fR ?\fIboolean\fR?
  336. If \fIboolean\fR has a true boolean value such as \fB1\fR or \fBon\fR
  337. then propagation is enabled for \fImaster\fR, which must be a window
  338. name (see ``GEOMETRY PROPAGATION'' below).
  339. If \fIboolean\fR has a false boolean value then propagation is
  340. disabled for \fImaster\fR.
  341. In either of these cases an empty string is returned.
  342. If \fIboolean\fR is omitted then the command returns \fB0\fR or
  343. \fB1\fR to indicate whether propagation is currently enabled
  344. for \fImaster\fR.
  345. Propagation is enabled by default.
  346. .TP
  347. \fBpack slaves \fImaster\fR
  348. Returns a list of all of the slaves in the packing order for \fImaster\fR.
  349. The order of the slaves in the list is the same as their order in
  350. the packing order.
  351. If \fImaster\fR has no slaves then an empty string is returned.
  352.  
  353. .SH "THE PACKER ALGORITHM"
  354. .PP
  355. For each master the packer maintains an ordered list of slaves
  356. called the \fIpacking list\fR.
  357. The \fB\-in\fR, \fB\-after\fR, and \fB\-before\fR configuration
  358. options are used to specify the master for each slave and the slave's
  359. position in the packing list.
  360. If none of these options is given for a slave then the slave
  361. is added to the end of the packing list for its parent.
  362. .PP
  363. The packer arranges the slaves for a master by scanning the
  364. packing list in order.
  365. At the time it processes each slave, a rectangular area within
  366. the master is still unallocated.
  367. This area is called the \fIcavity\fR;  for the first slave it
  368. is the entire area of the master.
  369. .PP
  370. For each slave the packer carries out the following steps:
  371. .IP [1]
  372. The packer allocates a rectangular \fIparcel\fR for the slave
  373. along the side of the cavity given by the slave's \fB\-side\fR option.
  374. If the side is top or bottom then the width of the parcel is
  375. the width of the cavity and its height is the requested height
  376. of the slave plus the \fB\-ipady\fR and \fB\-pady\fR options.
  377. For the left or right side the height of the parcel is
  378. the height of the cavity and the width is the requested width
  379. of the slave plus the \fB\-ipadx\fR and \fB\-padx\fR options.
  380. The parcel may be enlarged further because of the \fB\-expand\fR
  381. option (see ``EXPANSION'' below)
  382. .IP [2]
  383. The packer chooses the dimensions of the slave.
  384. The width will normally be the slave's requested width plus
  385. twice its \fB\-ipadx\fR option and the height will normally be
  386. the slave's requested height plus twice its \fB\-ipady\fR
  387. option.
  388. However, if the \fB\-fill\fR option is \fBx\fR or \fBboth\fR
  389. then the width of the slave is expanded to fill the width of the parcel,
  390. minus twice the \fB\-padx\fR option.
  391. If the \fB\-fill\fR option is \fBy\fR or \fBboth\fR
  392. then the height of the slave is expanded to fill the width of the parcel,
  393. minus twice the \fB\-pady\fR option.
  394. .IP [3]
  395. The packer positions the slave over its parcel.
  396. If the slave is smaller than the parcel then the \fB\-anchor\fR
  397. option determines where in the parcel the slave will be placed.
  398. If \fB\-padx\fR or \fB\-pady\fR is non-zero, then the given
  399. amount of external padding will always be left between the
  400. slave and the edges of the parcel.
  401. .PP
  402. Once a given slave has been packed, the area of its parcel
  403. is subtracted from the cavity, leaving a smaller rectangular
  404. cavity for the next slave.
  405. If a slave doesn't use all of its parcel, the unused space
  406. in the parcel will not be used by subsequent slaves.
  407. If the cavity should become too small to meet the needs of
  408. a slave then the slave will be given whatever space is
  409. left in the cavity.
  410. If the cavity shrinks to zero size, then all remaining slaves
  411. on the packing list will be unmapped from the screen until
  412. the master window becomes large enough to hold them again.
  413.  
  414. .SH "EXPANSION"
  415. .PP
  416. If a master window is so large that there will be extra space
  417. left over after all of its slaves have been packed, then the
  418. extra space is distributed uniformly among all of the slaves
  419. for which the \fB\-expand\fR option is set.
  420. Extra horizontal space is distributed among the expandable
  421. slaves whose \fB\-side\fR is \fBleft\fR or \fBright\fR,
  422. and extra vertical space is distributed among the expandable
  423. slaves whose \fB\-side\fR is \fBtop\fR or \fBbottom\fR.
  424.  
  425. .SH "GEOMETRY PROPAGATION"
  426. .PP
  427. The packer normally computes how large a master must be to
  428. just exactly meet the needs of its slaves, and it sets the
  429. requested width and height of the master to these dimensions.
  430. This causes geometry information to propagate up through a
  431. window hierarchy to a top-level window so that the entire
  432. sub-tree sizes itself to fit the needs of the leaf windows.
  433. However, the \fBpack propagate\fR command may be used to
  434. turn off propagation for one or more masters.
  435. If propagation is disabled then the packer will not set
  436. the requested width and height of the packer.
  437. This may be useful if, for example, you wish for a master
  438. window to have a fixed size that you specify.
  439.  
  440. .SH "RESTRICTIONS ON MASTER WINDOWS"
  441. .PP
  442. The master for each slave must either be the slave's parent
  443. (the default) or a descendant of the slave's parent.
  444. This restriction is necessary to guarantee that the
  445. slave can be placed over any part of its master that is
  446. visible without danger of the slave being clipped by its parent.
  447.  
  448. .SH "PACKING ORDER"
  449. .PP
  450. If the master for a slave is not its parent then you must make sure
  451. that the slave is higher in the stacking order than the master.
  452. Otherwise the master will obscure the slave and it will appear as
  453. if the slave hasn't been packed correctly.
  454. The easiest way to make sure the slave is higher than the master is
  455. to create the master window first:  the most recently created window
  456. will be highest in the stacking order.
  457. Or, you can use the \fBraise\fR and \fBlower\fR commands to change
  458. the stacking order of either the master or the slave.
  459.  
  460. .SH KEYWORDS
  461. geometry manager, location, packer, parcel, propagation, size
  462.